Eclipse Platform
Pre-release 3.0

org.eclipse.ui.activities
Interface IIdentifier

All Superinterfaces:
Comparable

public interface IIdentifier
extends Comparable

An instance of this interface can be obtained from an instance of IActivityManager for any identifier.

The handle-based nature of this API allows it to work well with runtime plugin activation and deactivation, which can cause dynamic changes to the extension registry.

This interface is not intended to be extended or implemented by clients.

EXPERIMENTAL

Since:
3.0
See Also:
IActivityManager

Method Summary
 void addIdentifierListener(IIdentifierListener identifierListener)
          Registers an instance of IIdentifierListener to listen for changes to properties of this instance.
 Set getActivityIds()
          Returns the set of activity ids that this instance matches.
 String getId()
          Returns the identifier of this instance.
 boolean isEnabled()
          Returns whether or not this instance is enabled.
 void removeIdentifierListener(IIdentifierListener identifierListener)
          Unregisters an instance of IIdentifierListener listening for changes to properties of this instance.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

addIdentifierListener

public void addIdentifierListener(IIdentifierListener identifierListener)
Registers an instance of IIdentifierListener to listen for changes to properties of this instance.

Parameters:
identifierListener - the instance to register. Must not be null. If an attempt is made to register an instance which is already registered with this instance, no operation is performed.

getActivityIds

public Set getActivityIds()
Returns the set of activity ids that this instance matches.

Notification is sent to all registered listeners if this property changes.

Returns:
the set of activity ids that this instance matches. This set may be empty, but is guaranteed not to be null. If this set is not empty, it is guaranteed to only contain instances of String.

getId

public String getId()
Returns the identifier of this instance.

Returns:
the identifier of this instance. Guaranteed not to be null.

isEnabled

public boolean isEnabled()
Returns whether or not this instance is enabled.

Notification is sent to all registered listeners if this property changes.

Returns:
true, iff this instance is enabled.

removeIdentifierListener

public void removeIdentifierListener(IIdentifierListener identifierListener)
Unregisters an instance of IIdentifierListener listening for changes to properties of this instance.

Parameters:
identifierListener - the instance to unregister. Must not be null. If an attempt is made to unregister an instance which is not already registered with this instance, no operation is performed.

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.